<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>v_hdmirxss: xhdmi_menu.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">v_hdmirxss
   </div>
   <div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xhdmi__menu_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a>  </div>
  <div class="headertitle">
<div class="title">xhdmi_menu.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file contains the Xilinx Menu implementation as used in the HDMI example design. </p>
<p>Please see <a class="el" href="xhdmi__menu_8h.html" title="This is the main header file for the Xilinx Menu implementation as used in the HDMI example design...">xhdmi_menu.h</a> for more details.</p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who  Date       Changes
<hr/>

X.X   ..   DD-MM-YYYY ..
1.0   RHe  10-07-2015 Initial version
1.1   MG   16-07-2015 Expanded menu options
1.2   MG   23-07-2015 Added EDID options
1.3   MG   05-08-2015 Added Audio menu
1.4   MG   03-02-2016 Added HDCP menu
1.5   MH   06-24-2016 Added HDCP repeater support.
1.6   YH   03-01-2017 Remove Video Pattern from UART menu when it is not
                            enabled in TPG XGUI (CR-961051)
                      Remove XV_HdmiRxSs_LoadDefaultEdid from UART menu
                      Added 480i and 576i Support in the UART
1.7   GM   01-02-2017 Change PLL Layout menu access to GTX only in
                             XHdmi_GtPllLayoutMenu API
1.8   mmo  02-03-2017 Added Support to Set HDMI TX to be on HDMI or
                              DVI Mode.
</pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a14b96491d9e48ad8fadbbb391d097ab6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xhdmi__menu_8c.html#a14b96491d9e48ad8fadbbb391d097ab6">Info</a> (void)</td></tr>
<tr class="memdesc:a14b96491d9e48ad8fadbbb391d097ab6"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function outputs the video timing , Audio, Link Status, HDMI RX state of HDMI RX core.  <a href="#a14b96491d9e48ad8fadbbb391d097ab6">More...</a><br /></td></tr>
<tr class="separator:a14b96491d9e48ad8fadbbb391d097ab6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab58fedfa2d83d72245cd759ff53c2c3b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xhdmi__menu_8c.html#ab58fedfa2d83d72245cd759ff53c2c3b">XHdmi_MenuInitialize</a> (<a class="el" href="struct_x_hdmi___menu.html">XHdmi_Menu</a> *InstancePtr, u32 UartBaseAddress)</td></tr>
<tr class="memdesc:ab58fedfa2d83d72245cd759ff53c2c3b"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function takes care of the HDMI menu initialization.  <a href="#ab58fedfa2d83d72245cd759ff53c2c3b">More...</a><br /></td></tr>
<tr class="separator:ab58fedfa2d83d72245cd759ff53c2c3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8507711886833ab068231566550c677e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xhdmi__menu_8c.html#a8507711886833ab068231566550c677e">XHdmi_MenuReset</a> (<a class="el" href="struct_x_hdmi___menu.html">XHdmi_Menu</a> *InstancePtr)</td></tr>
<tr class="memdesc:a8507711886833ab068231566550c677e"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function resets the menu to the main menu.  <a href="#a8507711886833ab068231566550c677e">More...</a><br /></td></tr>
<tr class="separator:a8507711886833ab068231566550c677e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d5275f81a5e4353687df46fd1bedb88"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xhdmi__menu_8c.html#a6d5275f81a5e4353687df46fd1bedb88">XHdmi_MenuProcess</a> (<a class="el" href="struct_x_hdmi___menu.html">XHdmi_Menu</a> *InstancePtr)</td></tr>
<tr class="memdesc:a6d5275f81a5e4353687df46fd1bedb88"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is called to trigger the HDMI menu statemachine.  <a href="#a6d5275f81a5e4353687df46fd1bedb88">More...</a><br /></td></tr>
<tr class="separator:a6d5275f81a5e4353687df46fd1bedb88"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a2d5525edd4cf0958da26f4eb70d24b85"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xhdmi__menu_8c.html#a2d5525edd4cf0958da26f4eb70d24b85">IsPassThrough</a></td></tr>
<tr class="memdesc:a2d5525edd4cf0958da26f4eb70d24b85"><td class="mdescLeft">&#160;</td><td class="mdescRight">Demo mode 0-colorbar 1-pass through.  <a href="#a2d5525edd4cf0958da26f4eb70d24b85">More...</a><br /></td></tr>
<tr class="separator:a2d5525edd4cf0958da26f4eb70d24b85"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="a14b96491d9e48ad8fadbbb391d097ab6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a14b96491d9e48ad8fadbbb391d097ab6">&#9670;&nbsp;</a></span>Info()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Info </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function outputs the video timing , Audio, Link Status, HDMI RX state of HDMI RX core. </p>
<p>In addition, it also prints information about HDMI TX, and HDMI GT cores.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">None.</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

</div>
</div>
<a id="ab58fedfa2d83d72245cd759ff53c2c3b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab58fedfa2d83d72245cd759ff53c2c3b">&#9670;&nbsp;</a></span>XHdmi_MenuInitialize()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XHdmi_MenuInitialize </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_hdmi___menu.html">XHdmi_Menu</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>UartBaseAddress</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function takes care of the HDMI menu initialization. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_hdmi___menu.html" title="The HDMI menu instance data. ">XHdmi_Menu</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

<p class="reference">References <a class="el" href="struct_x_hdmi___menu.html#a638ef2416724847ef77c5f624b1eb160">XHdmi_Menu::CurrentMenu</a>.</p>

</div>
</div>
<a id="a6d5275f81a5e4353687df46fd1bedb88"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d5275f81a5e4353687df46fd1bedb88">&#9670;&nbsp;</a></span>XHdmi_MenuProcess()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XHdmi_MenuProcess </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_hdmi___menu.html">XHdmi_Menu</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is called to trigger the HDMI menu statemachine. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_hdmi___menu.html" title="The HDMI menu instance data. ">XHdmi_Menu</a> instance.</td></tr>
    <tr><td class="paramname">input</td><td>is the value used for the next menu state decoder.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

</div>
</div>
<a id="a8507711886833ab068231566550c677e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8507711886833ab068231566550c677e">&#9670;&nbsp;</a></span>XHdmi_MenuReset()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XHdmi_MenuReset </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_hdmi___menu.html">XHdmi_Menu</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function resets the menu to the main menu. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_hdmi___menu.html" title="The HDMI menu instance data. ">XHdmi_Menu</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

<p class="reference">References <a class="el" href="struct_x_hdmi___menu.html#a638ef2416724847ef77c5f624b1eb160">XHdmi_Menu::CurrentMenu</a>.</p>

</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a2d5525edd4cf0958da26f4eb70d24b85"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d5525edd4cf0958da26f4eb70d24b85">&#9670;&nbsp;</a></span>IsPassThrough</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 IsPassThrough</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Demo mode 0-colorbar 1-pass through. </p>

<p class="reference">Referenced by <a class="el" href="xhdmi__example_8c.html#a13f636ef2d93d7ee10e421e5f604a510">I2cClk()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
  </ul>
</div>
</body>
</html>
